/*
 * Copyright 2006 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.spectaql;

import java.util.Collection;

/**
 * <p>
 * <code>QueryContext</code> defines the public interface to a query context. Each object which implements this class is
 * used to build exactly one dynamic query.
 * </p>
 *
 * TODO: string containment, startsWith, endsWith, list and set containsAny, containsAll, etc.
 */
public interface QueryContext
{
    /**
     * <p>
     * Create a matcher for a given entity class.
     * </p>
     *
     * @param clazz the entity class.
     * @return {@link Object} matcher entity.
     */
    <T> T matcher(Class<T> clazz) throws IllegalArgumentException;

    <T> ConstraintSetters<T> constrain(T propertyReference);

    <T> CollectionConstraintSetters<T> constrain(Collection<T> propertyReference);
}
